Updated the release script and readme #72
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oracle-contributor-agreement
bot
added
the
OCA Verified
ashu-bdvt
approved these changes
Sep 24, 2024
kolkheang
reviewed
Sep 25, 2024
RELEASE.md
Outdated
| @@ -12,8 +12,24 @@ Releasing the project requires these steps: | |||
| node scripts/release/release.js minor | |||
| ``` | |||
|
|
|||
| 2. The above release script should automatically update the package version and regenerate assets in ```dist``` & ```lib``` folders. Once assets are regenerated the script commits and tags the changes and will push them to remote and `npm publish` will be triggered automatically. | |||
| 3. Once publish is complete make sure it's uploaded to [npm][project-url] | |||
| 2. The above release script should automatically update the package version and regenerate assets in ```dist``` & ```lib``` folders. Once assets are regenerated the script commits the changes to a new branch and will push them to remote. Go to the branch repository on GitHub and create a PR from the newly created branch to the master branch. Once the PR is approved, merge it into the master branch. | |||
There was a problem hiding this comment.
Suggested change
| 2. The above release script should automatically update the package version and regenerate assets in ```dist``` & ```lib``` folders. Once assets are regenerated the script commits the changes to a new branch and will push them to remote. Go to the branch repository on GitHub and create a PR from the newly created branch to the master branch. Once the PR is approved, merge it into the master branch. | |
| 2. The above release script should automatically update the package version and regenerate assets in ```dist``` & ```lib``` folders. Once assets are regenerated the script commits the changes to a new branch and will push them to remote. Go to the branch repository on GitHub and create a PR from the newly created branch to the `master` branch. Once the PR is approved, merge it into the `master` branch. |
|
|
||
| After the PR is created and merged into the `master` branch, follow these steps to publish the npm package: | ||
|
|
||
| 1. **Pull the latest changes from the `master` branch**: |
There was a problem hiding this comment.
git checkout master
git pull origin master
There was a problem hiding this comment.
You can use the ``` for code block
| git checkout master | ||
| git pull origin master | ||
|
|
||
| 2. **Create a tag and push the tag**: |
There was a problem hiding this comment.
git tag v{x.x.x} # Replace {x.x.x} with the next release version
git push origin v{x.x.x} # Replace {x.x.x} with the next release version
You can use ``` for code block
| git push origin v{x.x.x} # Replace {x.x.x} with the next release version | ||
|
|
||
| 3. **Publish the package to the npm registry**: | ||
| npm publish |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated the release script and readme.
Release script test teminal logs: https://gist.github.com/Surya-Rnsit/b541fa5a4f9f4796791542fa5bcd5ddf
Tested Release branch: https://github.com/oracle-samples/cerner-smart-embeddable-lib/commits/release-minor-2024-09-20/